<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>canfd: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">canfd
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">canfd Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The Xilinx CANFD driver. This driver supports the Xilinx CANFD Controller.</p>
<p>The CANFD Controller supports the following features:</p><ul>
<li>Confirms to the ISO 11898-1, CAN 2.0A and CAN 2.0B standards.</li>
<li>Supports both Standard (11 bit Identifier) and Extended (29 bit Identifier) frames.</li>
<li>Supports Bit Rates up to 8 Mbps.</li>
<li>Transmit message object FIFO with a user configurable depth of up to 64 message objects.</li>
<li>Receive message object FIFO with a user configurable depth of up to 64 message objects.</li>
<li>Acceptance filtering through a user configurable number of up to 32 acceptance filters.</li>
<li>Loop Back mode for diagnostic applications.</li>
<li>Maskable Error and Status Interrupts.</li>
<li>Readable Error Counters.</li>
<li>External PHY chip required.</li>
<li>Backward compatiable for Legacy CAN.</li>
<li>Supports reception in Mailbox and Sequential Mode</li>
</ul>
<p>The device driver supports all the features listed above, if applicable.</p>
<p><b>Driver Description</b></p>
<p>The device driver enables higher layer software (e.g., an application) to communicate to the CANFD. The driver handles transmission and reception of CAN frames, as well as configuration of the controller. The driver is simply a pass-through mechanism between a protocol stack and the CANFD. A single device driver can support multiple CANFDs.</p>
<p>Since the driver is a simple pass-through mechanism between a protocol stack and the CANFD, no assembly or disassembly of CANFD frames is done at the driver-level. This assumes that the protocol stack passes a correctly formatted CANFD frame to the driver for transmission, and that the driver does not validate the contents of an incoming frame</p>
<p><b>Operation Modes</b></p>
<p>The CANFD controller supports the following modes of operation:</p><ul>
<li><b>Configuration Mode</b>: In this mode the CAN timing parameters and Baud Rate Pre-scalar parameters can be changed. In this mode the CAN controller loses synchronization with the CAN bus and drives a constant recessive bit on the bus line. The Error Counter Register are reset. The CAN controller does not receive or transmit any messages even if there are pending transmit requests from the TX FIFO or the TX High Priority Buffer. the Storage FIFOs and the CAN configuration registers are still accessible.</li>
<li><b>Normal Mode</b>:In Normal Mode the CAN controller participates in bus communication, by transmitting and receiving messages.</li>
<li><b>Sleep Mode</b>: In Sleep Mode the CAN Controller does not transmit any messages. However, if any other node transmits a message, then the CAN Controller receives the transmitted message and exits from Sleep Mode. If there are new transmission requests from either the TX FIFO or the TX High Priority Buffer when the CAN Controller is in Sleep Mode, these requests are not serviced, and the CAN Controller continues to remain in Sleep Mode. Interrupts are generated when the CAN controller enters Sleep mode or Wakes up from Sleep mode.</li>
<li><b>Loop Back Mode</b>: In Loop Back mode, the CAN controller transmits a recessive bit stream on to the CAN Bus. Any message that is transmitted is loop backed to the rx line and acknowledged. The CAN controller thus receives any message that it transmits. It does not participate in normal bus communication and does not receive any messages that are transmitted by other CAN nodes. This mode is used for diagnostic purposes.</li>
<li><b>Snoop mode</b>:in Snoop Mode,The CAN controller transmits recessive bit stream on to CAN bus and does not participate in normal bus communication but receives messages that are transmitted by other CAN nodes.Received messages are stored based on receive ID match result. Error counters are disabled and cleared to 0. Reads to error counter register will return zero.</li>
</ul>
<p><b>Buffer Alignment</b></p>
<p>It is important to note that frame buffers passed to the driver must be 32-bit aligned.</p>
<p><b>Receive Address Filtering</b></p>
<p>The device can be set to accept frames whose Identifiers match any of up to 32 filters set in the Acceptance Filter Mask/ID registers.</p>
<p>The incoming Identifier is masked with the bits in the Acceptance Filter Mask Register. This value is compared with the result of masking the bits in the Acceptance Filter ID Register with the Acceptance Filter Mask Register. If both these values are equal, the message will be stored in the RX FIFO.</p>
<p>Acceptance Filtering is performed by each of the defined acceptance filters. If the incoming identifier passes through any acceptance filter then the frame is stored in the RX FIFO.</p>
<p><b>PHY Communication</b></p>
<p>This driver does not provide any mechanism for directly programming PHY.</p>
<p><b>Interrupts</b></p>
<p>The driver has no dependencies on the interrupt controller. The driver provides an interrupt handler. User of this driver needs to provide callback functions. An interrupt handler example is available with the driver.</p>
<p><b>Virtual Memory</b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space and invoking function XCanFd_VmInitialize(), instead of XCanFd_Initialize(), to initialize the device at first.</p>
<p><b>Threads</b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b>Device Reset</b></p>
<p>Bus Off interrupt that can occur in the device requires a device reset. The user is responsible for resetting the device and re-configuring it based on its needs (the driver does not save the current configuration). When integrating into an RTOS, these reset and re-configure obligations are taken care of by the OS adapter software if it exists for that RTOS.</p>
<p><b>Device Configuration</b></p>
<p>The device can be configured in various ways during the FPGA implementation process. Configuration parameters are stored in the xcan_g.c files. A table is defined where each entry contains configuration information for a CAN device. This information includes such things as the base address of the memory-mapped device, and the number of acceptance filters.</p>
<p><b>Asserts</b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.</p>
<p><b>Building the driver</b></p>
<p>The XCanFd driver is composed of several source files.This allows the user to build and link only those parts of the driver that are necessary. <br />
<br />
</p>
<pre>
  Temp Change
  MODIFICATION HISTORY:</pre><pre>  Ver   Who  Date     Changes
<hr/>

  1.0   nsk  06/04/15 First release
  1.0   nsk  15/05/15 Updated <a class="el" href="xcanfd_8c.html">xcanfd.c</a> for correct AFRID and AFRMSK Registers
                      Updated <a class="el" href="xcanfd_8c.html">xcanfd.c</a> and <a class="el" href="xcanfd_8h.html">xcanfd.h</a> to get configurable
                      TxBuffers in XCanFd_Config Struct and
                      <a class="el" href="group__canfd__v1__0.html#ga7450b3856ad1539c7a8ed0649b8efab7" title="This Routine returns the Free Buffer out of 32 Transmit Buffers. ">XCanFd_GetFreeBuffer()</a>.
                      Modified XCANFD_BTR_TS1_MASK in <a class="el" href="xcanfd__hw_8h.html">xcanfd_hw.h</a>.
                      Updated <a class="el" href="xcanfd_8c.html">xcanfd.c</a> while sending data when EDL is Zero.
                      Updated driver tcl file to get configurable TxBuffers.
                      (CR 861772).
  1.0   nsk  16/06/15 Updated <a class="el" href="group__canfd__v1__0.html#gae93c2c9dd933e4258b9d4118c4bf6220" title="This function receives a CAN Frame in MAIL BOX Mode. ">XCanFd_Recv_Mailbox()</a>, <a class="el" href="group__canfd__v1__0.html#gaaa893768ea4f0db5796f31ab3d8ca431" title="This function allows the CAN device to enter one of the following operation modes: ...">XCanFd_EnterMode()</a>
                      <a class="el" href="group__canfd__v1__0.html#ga8e1df3e2b6ed809dda14de08d8b6d0a5" title="This routine returns current operation mode the CAN device is in. ">XCanFd_GetMode()</a> in <a class="el" href="xcanfd_8c.html">xcanfd.c</a> and Added new definition
                      for Register bits in <a class="el" href="xcanfd__hw_8h.html">xcanfd_hw.h</a> and updated
                      <a class="el" href="group__canfd__v1__0.html#ga9576c384b9ef2e8436298b5947010f90" title="This routine is the interrupt handler for the CAN driver. ">XCanFd_IntrHandler()</a> in <a class="el" href="xcanfd__intr_8c.html">xcanfd_intr.c</a> as per new RTL.
                      Changes in RTL, Added new bits to MSR,SR,ISR,IER,ICR
                      Registers and modified TS2 bits in BTR and F_SJW bits
                      in F_BTR Registers.
  1.1   sk   11/10/15 Used UINTPTR instead of u32 for Baseaddress CR# 867425.
                      Changed the prototype of XCanFd_CfgInitialize API.
  1.2   mi   09/22/16 Fixed compilation warnings.
        ms   01/23/17 Modified xil_printf statement in main function for all
                      examples to ensure that "Successfully ran" and "Failed"
                      strings are available in all examples. This is a fix
                      for CR-965028.
        ms   03/17/17 Added readme.txt file in examples folder for doxygen
                      generation.
  </pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
